docs: document API key authentication on API specs page - #447
Merged
Conversation
Signed-off-by: Sai Asish Y <say.apm35@gmail.com>
Member
|
@SAY-5 thank you! That actually made me notice we need even more adjustments. :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The API Specs page only listed Basic HTTP authorization, so readers had no indication that API keys are the supported and recommended way to authenticate (and that writes require one). This adds the
Authorization: Api-Key <KEY>header to the authentication section and links to the existing API keys guide, matching the wording already used in the how-to and the API-keys blog posts.Fixes peeringdb/peeringdb#2010